home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Diamond Collection / The Diamond Collection (Software Vault)(Digital Impact).ISO / cdr37 / zlist_20.zip / ZLIST.DOC < prev    next >
Text File  |  1995-03-13  |  19KB  |  357 lines
  1.  
  2.  
  3.  
  4.  
  5.   ╔════════════════════════════════════╗
  6.   ║      ▄      ▄         ▄█▄ ▄███▄    ║
  7.   ║    ▄▀██▄▄  ▀██▄▄      ██▌▐██▀▐█▌   ║░░
  8.   ║   ██▌▐█████▄▐█████▄  ▐██ ██   ▀    ║░░
  9.   ║  ▐██ ███▀▀██▌▐█▀▀██▌ ██▌▐█▌        ║──────────────────────────────────────
  10.   ║   ▀ ▐██    ██▐    ██▐██ ██         ║   ZippyList - (C) Copyright 1994
  11.   ║─────███▌──▐██▐▌──▐██▐█▌▐█▌─────────║    Whitewater Technologies, Inc.
  12.   ║    ▐████▄▄██▌██▄▄██▌██ ▐██         ║       Author: Gregg Graubins
  13.   ║    ██▌▀████▀ ▀████▀▐█▌  ██▌    █▌  ║──────────────────────────────────────
  14.   ║   ▐██▌   ▄▄█      ▐██    ██▄  ▐█▌  ║░░
  15.   ║   ▐██   ▐██▌      ██  ▄▄█▀▀██▄█▀   ║░░
  16.   ║    ██▌   ██▌     ▐█████▀    ▀▀     ║░░  *ALL* Source Code has been done
  17.   ║     ██    ██      ▀▀▀              ║░░  by Whitewater Technologies, Inc.
  18.   ║      ▀▌    ▀▌                      ║░░
  19.   ╚════════════════════════════════════╝░░
  20.     ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
  21.  
  22.   Licensed for distribution to DavaSoft BBS (718-967-6827) (support@dava.com)
  23.  
  24. ╒═════════════════════════════════════════════════════════════════════════════╕
  25. │                                                                             │
  26. │ ZippyList, along with all of our other utilities, is made for TOTAL Sysop   │
  27. │ flexibility - As well as ease of use! To become familiar with ZippyList,    │
  28. │ please continue to read with the documentation.                             │
  29. │                                                                             │
  30. │ ZippyList is has FULL multi-language support. The display files will be     │
  31. │ checked for any language extensions and/or security specific display files  │
  32. │ and be displayed accordingly.                                               │
  33. │                                                                             │
  34. │ The ZTEXT file will also allow you to add your own extension! If an         │
  35. │ extension is accompanied by the ZTEXT file, ZippyList will check to see if  │
  36. │ an extension exists with the current language. If not, the default ZTEXT    │
  37. │ file will be loaded.                                                        │
  38. │                                                                             │
  39. │─────────────────────────────────────────────────────────────────────────────│
  40. │                                                                             │
  41. │ NOTE: Some features are *not* documented. Please execute ZippyList for your-│
  42. │       self and see it in action! :)                                         │
  43. │                                                                             │
  44. ╘═════════════════════════════════════════════════════════════════════════════╛
  45.  
  46.   License
  47.   ────────────────────────────────────────────────────────────────────────
  48.   You are granted a personal non-exclusive, non-transferable license to
  49.   use the enclosed program and documentation solely for your own internal
  50.   needs on one central processing unit or network of physically connected
  51.   computers. You assume the entire responsibility for the selection of
  52.   the program to achieve your intended results, and for the installation,
  53.   use and results obtained from the program.
  54.  
  55.  
  56.   Disclaimer
  57.   ────────────────────────────────────────────────────────────────────────
  58.   ZIPPYLIST AND ANY ACCOMPANYING SOFTWARE ARE PROVIDED "AS IS" WITHOUT
  59.   WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
  60.   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR  A
  61.   PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE
  62.   IS WITH YOU. SHOULD THIS SOFTWARE AFFECT YOUR SYSTEM(S), YOU ASSUME THE
  63.   ENTIRE COST OF SERVICING, OR CORRECTION. IN NO EVENT WILL THE AUTHOR BE
  64.   LIABLE TO YOU FOR ANY DAMAGES ARISING OUT OF THE USE, OR INABILITY TO
  65.   USE, OF ZIPPYLIST'S PACKAGE.
  66.  
  67.   Installing ZippyList into your PCBoard system
  68.   ────────────────────────────────────────────────────────────────────────
  69.   ZippyList is a very easy program to install. After reading and following
  70.   the steps to installing ZippyList, please read the section labeled
  71.   "Configuring Display & Menu files" (If you would like to alter the
  72.   display files, menu files, etc.)
  73.  
  74.   Although ZippyList may be executed from anywhere inside PCBoard's
  75.   environment, whether it be display files (Using the "!" command) or any
  76.   other way, the most common (And recommended) installation is through the
  77.   .CMD files. During this section, the examples relate to installing
  78.   ZippyList through your .CMD files.
  79.  
  80.   Installation precedures:
  81.   ========================
  82.  
  83.    1) Before configuring *any* files, you should have already extracted the
  84.       contents of the zipfile into a directory.
  85.  
  86.       (We use and recommend C:\PCB\PPE\ZLIST)
  87.  
  88.    2) Enter PCBSETUP | File Locations | Configuration Files and edit
  89.       your default .CMD file. Add the following command:
  90.  
  91.           Command     Security  PPE/MNU File -or- Keystroke Replacement
  92.       ══════════════  ════════  ═══════════════════════════════════════
  93.       LIST                 25   C:\PCB\PPE\ZLIST\ZLIST.PPE
  94.  
  95.       Once you've added the above into your .CMD file, exit & save your
  96.       configuration.
  97.  
  98.       Note: You may have ZippyList installed into a *different* .CMD file,
  99.       in which case just add the command wherever you wish. You may also
  100.       have a different command/security/path than what is shown above.
  101.  
  102.    3) Edit your $$LOGOFF.BAT and add the following command:
  103.  
  104.       $$LOGOFF.BAT
  105.       ============
  106.       IF EXIST C:\PCB\NODE%PCBNODE%\WORK\WHITE.ZIP DEL C:\PCB\NODE%PCBNODE%\WHITE.ZIP
  107.  
  108.       Note: You may have a different Temporary path configured - In which
  109.             case, just change the above line to correspond to your
  110.             configuration. :)
  111.  
  112.    4) The last configuration step is to edit your ZLIST.CFG file. Use a
  113.       standard text editor (i.e. Qedit, TSE, etc.) to edit this file and
  114.       alter it. The format of the ZLIST.CFG is as follows:
  115.  
  116.     ────────────────────────[ ZLIST.CFG Format ]────────────────────────
  117.     Line  1: Sysop Name
  118.     Line  2: BBS Name
  119.     Line  3: Registration Number
  120.     Line  4: Toggle to whether or not to always display welcome file.
  121.  
  122.                 YES = Always display - Regardless of expert mode.
  123.                 NO  = If user has expert mode ON, ignore the display of
  124.                       the welcome file. Vise-Versa if they have expert
  125.                       mode toggled OFF.
  126.  
  127.     Line  5: Toggle to whether or not to ignore the EXPERT mode. If line
  128.              4 is "NO" and this is set to "YES", then the menus will
  129.              *always* be displayed and the welcome file will only be
  130.              displayed if the user had their expert mode OFF.
  131.  
  132.                 YES = Ignore expert mode; Display *ALL* menus regardless
  133.                       of expert mode.
  134.                 NO  = Don't ignore expert mode; Display menus ONLY if the
  135.                       user does NOT have expert mode on.
  136.  
  137.  ┌─ Line  6: Name of WELCOME File ─ Must be in curr. dir!
  138.  ├─ Line  7: Name of Main Menu file
  139.  ├─ Line  8: Name of Search Menu file
  140.  ├─ Line  9: Name of Search Text Menu file
  141.  ├─ Line 10: Name of Search by Filename Menu file
  142.  ├─ Line 11: Name of Search by Date Menu file
  143.  ├─ Line 12:■<This is Reserved for future use>
  144.  ├─ Line 13: Name of Execution Command display file
  145.  ├─ Line 14: Name of Clear Workspace display file
  146.  ├─ Line 15: Name of (Main Menu) HELP file
  147.  ├─ Line 16: Name of (Search Menu) HELP file
  148.  ├─ Line 17: Name of (Text Search Operation Menu) HELP file
  149.  ├─ Line 18: Name of (File Search Operation Menu) HELP file
  150.  ├─ Line 19: Name of (Date Search Operation Menu) HELP file
  151.  ├─ Line 20: Name of ZTEXT file
  152.  ├─ Line 21: File to display BEFORE scanning
  153.  ├─ Line 22: File to display WHILE scanning
  154.  ├─ Line 23: File to display AFTER scanning is completed
  155.  ├─ Line 24: Name of File to insert in the beginning of capture file;
  156.  │           Useful if you would like to explain a little about the
  157.  │           contents of the file the user downloaded.
  158.  ├─ Line 25:■<This is Reserved for future use>
  159.  ├─ Line 26: Name of Capture file to include inside Compressed file.
  160.  ├─ Line 27: Name of Compressed file to create
  161.  │
  162.  └────────┬─ Lines 6-24 must pertain in the ZippyList directory.
  163.           └─ Lines 6-27 should not include any path information.
  164.  
  165.  ┌─ Line 28: Temporary Work Directory
  166.  ├─ Line 29: Compression program filename (Path is optional, but recommended)
  167.  ├─ Line 30: Additional Parameters to pass to compression program.
  168.  ├─ Line 31: Directory to place Compressed Zipfile in.
  169.  │           Note: BE SURE TO INCLUDE THIS IN THE DLPATH.LST IF USING THE
  170.  │                 PRIMARY ZLIST.PPE FILE (See Below Notes).
  171.  │
  172.  └─────────  For lines 28-31, the following environment variables will
  173.              be converted (if used):
  174.  
  175.                   %PCBNODE%   - PCBoard Node Number
  176.                   %PCBDRIVE%  - Drive letter of PCBoard (i.e. C:)
  177.                   %PCBDIR%    - PCBoard's Home Directory
  178.  
  179.          (*) If you are a multi-node system and would like to refrain from
  180.              placing each node's work directory (i.e. C:\PCB\NODE1\WORK,
  181.              C:\PCB\NODE2\WORK, etc.) inside your DLPATH.LST, you may want
  182.              to use ZLIST-2.PPE - This will first FLAG the capture file for
  183.              download and then DOWNLOAD the file. As a result, the user will
  184.              be prompted with "Download Flagged Files? (Y)".
  185.  
  186.              For line 26, the following additional variables will be
  187.              converted if they exist:
  188.  
  189.                   @COMPFILE@  - Full path/filename of Compressed file
  190.                                 to be created.
  191.                   @ZCAPFILE@  - Full path/filename of Capture file to
  192.                                 be compressed.
  193.  
  194.              ZippyList is made for configurability! You may include
  195.              a file (or files) inside the compressed file by adding
  196.              your own commands to line 26.
  197.     ──────────────────────────────────────────────────────────────────
  198.  
  199.  
  200.   Work Space Creation/Deletion (Optional, but STRONGLY suggested)
  201.   ────────────────────────────────────────────────────────────────────────
  202.   An additional configuration step may be desired by those Sysop's who
  203.   would like to save some hard drive space. By default, ZippyList will
  204.   delete the files in the work directory each time it executes. If you
  205.   decide to delete the work files each time the user logs off, you must
  206.   edit your $$LOGOFF.BAT in your PCBoard 'Home' Directory (We have ours
  207.   pertain in the \PCB directory) and add the following:
  208.  
  209.  
  210.   $$LOGOFF.BAT
  211.   ============
  212.   IF EXIST C:\PCB\NODE%PCBNODE%\WORK\DAVA.ZIP DEL C:\PCB\NODE%PCBNODE%\WORK\DAVA.ZIP
  213.  
  214.  
  215.   Note: The above *must* be changed to correspond with your configuration!
  216.  
  217.   Configuring Display & Menu files
  218.   ────────────────────────────────────────────────────────────────────────
  219.   The most important feature of ZippyList is the configurability it has.
  220.   It will allow you to alter the way *ANY* of the Menu files, Display
  221.   files, or even prompts! If you would like to alter any of the prompts,
  222.   just edit the ZTEXT.<ext> prompt file and change it accordingly. If you
  223.   would like to change the display and/or menu files, below is a list of
  224.   the available variables that may be used in each:
  225.  
  226.  
  227.     Filename(s)  Variable(s) converted / Description (Returns)
  228.     ──────────────────────────────────────────────────────────────────────
  229.     ZMAIN ────┬─ @OPTEXT@ = Latest command ready for execution
  230.     ZSEARCH ──┤             ZippyList will automatically remember the
  231.     ZEXECMD ──┤             last search operation function the user
  232.     ZCLEAR ───┘             entered and store it into this variable.
  233.  
  234.  
  235.     ZSRCHTXT ─── @MATCHING@    = (M)atching Text (Blank if none)
  236.                  @EXCLUDING@   = (E)xcluding Text (Blank if none)
  237.                  @FILEDATE@    = (N)ew Date (000000 if none)
  238.                  @DIRECTORIES@ = (D)irectories to search
  239.                                  ZippyList will automatically 'shorten'
  240.                                  this length and parse out multiple
  241.                                  occurences of commas (,), P's (Private
  242.                                  Directory search), and will detect if an
  243.                                  "A" is found anywhere inside this field
  244.                                  and take action.
  245.                  @FLAGDL@      = A "Yes" or "No" text telling whether or
  246.                                  not the user is (F)lagging the file(s)
  247.                                  found for later download.
  248.                                           (Defaults to "No")
  249.                  @CAPTURE@     = A "Yes" or "No" text telling whether or
  250.                                  not the user if (C)apturing the search
  251.                                  into a file for flagging/download.
  252.                                           (Defaults to "Yes")
  253.                  @SRCHCMD@     = String containing the execution command.
  254.                                  This is useful to help the user become
  255.                                  more familiar with PCBoard's commands.
  256.                                            ("(N/A)" if none)
  257.  
  258.  
  259.   (Continued) Configuring Display & Menu files
  260.   ────────────────────────────────────────────────────────────────────────
  261.  
  262.     ZSRCHFLE ─── @FILENAME@    = (M)atching filename (Blank if none)
  263.                  @DIRECTORIES@ = (D)irectories to search (Defaults to "A")
  264.                                  ZippyList will automatically 'shorten'
  265.                                  this length and parse out multiple
  266.                                  occurences of commas (,), P's (Private
  267.                                  Directory search), and will detect if an
  268.                                  "A" is found anywhere inside this field
  269.                                  and take action.
  270.                  @FILEDATE@    = (N)ew Date (000000 if none)
  271.                  @FLAGDL@      = A "Yes" or "No" text telling whether or
  272.                                  not the user is (F)lagging the file(s)
  273.                                  found for later download.
  274.                                           (Defaults to "No")
  275.                  @CAPTURE@     = A "Yes" or "No" text telling whether or
  276.                                  not the user if (C)apturing the search
  277.                                  into a file for flagging/download.
  278.                                           (Defaults to "Yes")
  279.                  @SRCHCMD@     = String containing the execution command.
  280.                                  This is useful to help the user become
  281.                                  more familiar with PCBoard's commands.
  282.                                            ("(N/A)" if none)
  283.  
  284.  
  285.     ZSRCHDTE ─── @FILEDATE@    = (N)ew Date (Last Date of Search if none)
  286.                  @DIRECTORIES@ = (D)irectories to search (Defaults to "A")
  287.                                  ZippyList will automatically 'shorten'
  288.                                  this length and parse out multiple
  289.                                  occurences of commas (,), P's (Private
  290.                                  Directory search), and will detect if an
  291.                                  "A" is found anywhere inside this field
  292.                                  and take action.
  293.                  @FLAGDL@      = A "Yes" or "No" text telling whether or
  294.                                  not the user is (F)lagging the file(s)
  295.                                  found for later download.
  296.                                           (Defaults to "No")
  297.                  @CAPTURE@     = A "Yes" or "No" text telling whether or
  298.                                  not the user if (C)apturing the search
  299.                                  into a file for flagging/download.
  300.                                           (Defaults to "Yes")
  301.                  @SRCHCMD@     = String containing the execution command.
  302.                                  This is useful to help the user become
  303.                                  more familiar with PCBoard's commands.
  304.                                            ("(N/A)" if none)
  305.  
  306.  
  307.  
  308.  
  309.   Extensive Logging of ALL functions
  310.   ────────────────────────────────────────────────────────────────────────
  311.   ZippyList will automatically log *every* function that is executed while
  312.   the user is inside. When a Sysop is viewing the caller's log, you will
  313.   notice that all Errors are displayed in red - These are most likely
  314.   errors that were found because of either (a) Your compression program
  315.   was not found or (b) a display/menu file was not found.
  316.  
  317.  
  318.  
  319.   Support and Registration
  320.   ────────────────────────────────────────────────────────────────────────
  321.   There are various methods of Customer Support we will provide:
  322.  
  323.     1) Call our Support BBS (Shown Below) and enter our Support Conference,
  324.        shown in the (J)oin Conference listing.
  325.  
  326.     2) Send direct Internet email to Gregg Graubins <splash@mcs.net>
  327.  
  328.   A lot of work has gone into this program to make it what it is. If you
  329.   find ZippyList useful, please consider the time and work we put in to
  330.   make it possible. :) Our software will always be low in price for what it
  331.   does. There are some out there that are charging outrageous amounts of
  332.   money for such a simple program, and we are making software as an
  333.   alternative (And even better <g>) to those programs.
  334.  
  335.   You may register ZippyList (Or any of our other products) online via our
  336.   Support BBS below, or by calling us during standard business hours.
  337.   (WE ALSO ACCEPT CREDIT CARD PURCHASES) The registration is only $__ US.
  338.   Once registered, the minor delay in the beginning will be removed, all
  339.   features will be enabled for your use, and will enable you to obtain
  340.   future minor versions free of charge.
  341.  
  342.                           Our mailing address:
  343.  
  344.                THE DAVASOFT BBS
  345.                C\O ZIPPYLIST
  346.                            P.O. BOX 080466
  347.                            Staten Island, N.Y. 10312
  348.  
  349.      All new versions of ZippyList may be obtained on our Support BBS:
  350.  
  351.                            THE DAVASOFT BBS
  352.  
  353.        BBS: 718-967-6827  VOICE: 718-967-5713  FAX: 718-967-5848
  354.        TELENET: 204.176.6.5 or DAVA.COM  FTP SITE: FTP.DAVA.COM
  355.  
  356.   ────────────────────────────────────────────────────────────────────────
  357.